PolyList
Type
widget
Summary
This widget that allows us to display our data as a list.
Description
PolyList is a widget that allows us to display data in a list format. This widget has enormous power when it comes to displaying data, with customization being one of its most powerful features. It allows you to create multiple layouts with it using the same control type and even multiple layouts for the same control.
Children Properties
Message
| Name | Summary | Syntax |
|---|---|---|
| itemFirstDraw | This message is sent when a list item is showed the first time. | itemFirstDraw <pItemIndex> |
| selectionChanged | This message is sent when the selection is changed. | selectionChanged (pPreviousSelectionIndex,pNewSelectionIndex) |
| subItemMouseMove | This message is sent when the mouse is moved over a subitem. | subItemMouseMove (pItemIndex,pSubItemName) |
| subItemMouseLeave | This message is sent when the mouse leaves a subitem's rect. | subItemMouseLeave (pItemIndex, pSubItemName) |
| subItemMouseEnter | This message is sent when the mouse enters a subitem's rect. | subItemMouseEnter (pItemIndex, pSubItemName) |
| subItemClick | This message is sent when the user clicks a subitem. | subItemClick (pItemIndex, pSubItemName, pMouseButton) |
| itemMouseEnter | This message is sent when the mouse enter into an item's rectangle. | itemMouseEnter pItem |
| itemMouseLeave | This message is sent when the mouse leaves the item's rectangle. | itemMouseLeave pItem |
| itemClick | This message is sent when the user clicks an item. | itemClick (pItemIndex, pMouseButton) |
| scrollerDidScroll | This message is sent when the widget's content is scrolled. | scrollerDidScroll |
Property
| Name | Summary | Syntax |
|---|---|---|
| addItemBefore | Adds one or more items before item index itemPointer. | set the addItemBefore of widget to <list> |
| hScroll | Experimental | get the hScroll of widget |
| enableItemCache | Use cache when rendering list items. | set the enableItemCache of widget to <Boolean> get the enableItemCache of widget |
| csvData | The csvData property reflects the content in CSV format. | set the csvData of widget to <CSV> get the csvData of widget |
| multiHilite | Specifies if the PolyList widget will allow to select more than one row at the same time | set the multiHilite of widget to {true | false} get the multiHilite of widget |
| addData | A method for adding data to the list. | set the addData of widget to <List> |
| itemHeight | Establish the height of the item of the list. | set the itemHeight of widget to <integer> get the itemHeight of widget |
| plItemColor | Defines the background color of the list items. | set the plItemColor of widget to <RGBA Color> get the plItemColor of widget |
| itemRoundedRadius | The radius of the corners of the elements in the list. | set the itemRoundedRadius of widget to <integer> get the itemRoundedRadius of widget |
| itemPointer | It's a pointer to tell the itemContent property about which item to act on. | set the itemPointer of widget to <integer> get the itemPointer of widget |
| plHoverColor | The color of the item the mouse is over. | set the plHoverColor of widget to <RGBA Color> get the plHoverColor of widget |
| numberOfElements | Reports the total number of elements in a PolyList. | set the numberOfElements of widget to 20 get the numberOfElements of widget |
| addItemAfter | Adds one or more items after item index itemPointer. | set the addItemAfter of widget to <list> |
| useOverlays | Draws the rectangle that indicates that an element is selected on top of the item. | set the useOverlays of widget to {true | false} get the useOverlays of widget |
| mouseItem | Get item index under the cursor | get the mouseItem of widget |
| subItemRect | Gets the bounding rect of a specific sub item. | get the subItemRect of widget |
| dataHeight | Reports the height needed by an object to display its full contents without scrolling. | get the dataHeight of widget |
| imageResizeQuality | The quality used when resizing images. | set the imageResizeQuality of widget to {none | low | medium | high} get the imageResizeQuality of widget |
| addSingleItem | A method for adding an item to the list. | set the addSingleItem of widget to <Array> |
| subItemPointer | It's a pointer to tell the subItemContent property about which item to act on. | set the subItemPointer of widget to <String> get the subItemPointer of widget |
| strokeItems | Specifies whether to draw the borders of the PolyList elements. | set the strokeItems of widget to {true| false} get the strokeItems of widget |
| scrollbarWidth | Get or set the width of the scrollbar | set the scrollbarWidth of widget to <integer> get the scrollbarWidth of widget |
| enableImageCache | Use cache when rendering list items. | set the enableImageCache of widget to <Boolean> get the enableImageCache of widget |
| Margin | Specifies the margin that all the elements of a list will have in the PolyList. | set the margin of widget to <integer> get the margin of widget |
| dataLayout | Defines how each item in the list is drawn. | set the dataLayout of widget to <Array> get the dataLayout of widget |
| roundedRadius | The radius of the corners of the widget. | set the roundedRadius of widget to <integer> get the roundedRadius of widget |
| hilitedItemIndex | Specifies the item that will be hilited on a PolyList control. | set the hilitedItemIndex of widget to <integer> get the hilitedItemIndex of widget |
| plItemColorAlt | Defines the background color of the list items. | set the plItemColorAlt of widget to <RGBA Color> get the plItemColorAlt of widget |
| scroll | Specifies the vertical scroll of a PolyList. | set the scroll of widget to {<integer>} get the scroll of widget |
| itemContent | Gets and sets the value of the content of an item in list. | set the itemContent of widget to <Array> get the itemContent of widget |
| plHiliteColor | The color of the highlighted item of list. | set the plHiliteColor of widget to <RGBA Color> get the plHiliteColor of widget |
| hilitedItemData | Get or set the array of selected data corresponding to the selected item in the PolyList. | set the hilitedItemData of widget to <DataArray> get the hilitedItemData of widget |
| showGrid | Draw a grid between items of the list. | set the showGrid of widget to <Boolean> get the showGrid of widget |
| columnWidth | Establish the column width of the list. | set the columnWidth of widget to <integer> get the columnWidth of widget |
| plBorderColor | Defines the color with which the borders are drawn in PolyList. | set the plBorderColor of widget to <RGBA Color> get the plBorderColor of widget |
| touchScrolling | Specifies if the PolyList widget will respond to mouse scrolling gestures | set the touchScrolling of widget to {true | false} get the touchScrolling of widget |
| autoHilight | Defines if the PolyList highlights when an item is clicked. | set the autoHilite of widget to {true | false} get the autoHilite of widget |
| numberOfColumns | Set up and get the number of columns displayed in the PolyList | set the numberOfColumns of widget to {<integer>} get the numberOfColumns of widget |
| hoverWithMouse | Defines if the PolyList highlights the item on which the mouse is. | set the hoverWithMouse of widget to {true | false} get the hoverWithMouse of widget |
| lastItemInView | The last visible or partially visible item of the list. | get the lastItemInView of widget |
| padding | Creates extra space within the widget. | set the padding of widget to <List> |
| mouseHoverHilite | Show the mouse item when the mouse is moved | set the mouseHoverHilite of widget to {true | false} get the mouseHoverHilite of widget |
| vScrollBar | Show or hide built-in vertical scrollbar. | set the vScrollBar of widget to <String> get the vScrollBar of widget |
| deleteItem | Delete items. | set the deleteItem of widget to <List> |
| alternateItemColors | Set to true to alternate the background colors of every other row. | set the alternateItemColors of widget to <Boolean> get the alternateItemColors of widget |
| dataContent | Get or set the data array that the PolyList will display. | set the dataContent of widget to <DataArray> get the dataContent of widget |
| firstItemInView | The first visible or partially visible item of the list. | get the firstItemInView of widget |
| subItemContent | Gets and sets the value of the content of an item in list. | set the subItemContent of widget to <Array> get the subItemContent of widget |
| plBackgroundColor | Specifies the background color of list. | set the plBackgroundColor of widget to <RGBA Color> get the plBackgroundColor of widget |
| itemRect | Gets the rect of a list item. | get the itemRect of widget |
| dataWidth | Reports the width needed by an object to display its full contents without scrolling. | get the dataWidth of widget |
| strokeBody | Specifies whether to draw the borders of the PolyList body. | set the strokeBody of widget to {true| false} get the strokeBody of widget |
| tsvData | The tsvData property reflects the content in TSV format. | set the tsvData of widget to <TSV> get the tsvData of widget |
| borderWidth | Specifies the thickness with which borders are drawn on the PolyList. | set the borderWidth of widget to <integer> get the borderWidth of widget |